Public REST API

/checker/api/v1/diagnosis/

Diagnosis
POST
Parameters: (
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/diagnosis/{reference}/

Diagnosis
PUT
Parameters: (
reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
GET
Parameters: (
reference, type: string
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
PATCH
Parameters: (
reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
DELETE
Parameters: (
reference, type: string
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/diagnosis/{reference}/move_down/

Diagnosis
POST
Parameters: (
reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/diagnosis/{reference}/move_up/

Diagnosis
POST
Parameters: (
reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ CheckerDiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/category/

This returns a list of all valid categories in the system

Category
GET
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/category/{code}/

This returns a list of all valid categories in the system

Category
GET
Parameters: (
code, type: string
)
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/checker/api/v1/case/

Case
POST
Parameters: (
[eligibility_check] type: field
personal_details, type: field
[requires_action_at] type: datetime
[adaptation_details] type: field
[thirdparty_details] type: field
)
→ CaseSerializer(
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[adaptation_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[eligibility_check] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[thirdparty_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/organisation/

Article
GET
→ ArticleSerializer(
[website] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[geographic_coverage] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type_of_service] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 770644, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[accessibility] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[service_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[public_description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 770720, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[service_tag] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[when_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[how_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
resource_type, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
telephone_numbers, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[address] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[keywords] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[opening_hours] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
categories, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/organisation/{pk}/

Article
GET
Parameters: (
pk, type: string
)
→ ArticleSerializer(
[website] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[geographic_coverage] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type_of_service] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 770644, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[accessibility] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[service_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[public_description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 770720, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[service_tag] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[when_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[how_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
resource_type, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
telephone_numbers, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[address] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[keywords] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[opening_hours] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
categories, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/eligibility_check/

Eligibility_Check
POST
Parameters: (
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/eligibility_check/{reference}/

Eligibility_Check
PUT
Parameters: (
reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Eligibility_Check
GET
Parameters: (
reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Eligibility_Check
PATCH
Parameters: (
reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/eligibility_check/{reference}/is_eligible/

Eligibility_Check
POST
Parameters: (
reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/eligibility_check/{reference}/validate/

Eligibility_Check
GET
Parameters: (
reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/reasons_for_contacting/

Reason_For_Contacting
POST
Parameters: (
[reasons] type: field
[other_reasons] type: string
[case] type: field
[referrer] type: string {‘max’: 255, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘min’: None}
)
→ ReasonForContactingSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reasons] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[referrer] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[other_reasons] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/checker/api/v1/reasons_for_contacting/{reference}/

Reason_For_Contacting
PUT
Parameters: (
reference, type: string
[reasons] type: field
[other_reasons] type: string
[case] type: field
[referrer] type: string {‘max’: 255, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘min’: None}
)
→ ReasonForContactingSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reasons] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[referrer] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[other_reasons] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Reason_For_Contacting
PATCH
Parameters: (
reference, type: string
[reasons] type: field
[other_reasons] type: string
[case] type: field
[referrer] type: string {‘max’: 255, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘min’: None}
)
→ ReasonForContactingSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reasons] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[referrer] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[user_agent] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[other_reasons] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)